This API is used to Remove line/member from the MultiLine group.
URL
https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/organization/{id}
url Param
| name | type | description | required |
|---|
| businessId | String | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| id | string | MultiLine Group User ExternalID | Y |
| name | type | description | required |
|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Request
curl --location 'https:
--header 'X-Correlation-ID: 644e1dd793kjsdfjei' \
--header 'client_id: abcdefg' \
--header 'client_secret: 12345678' \
--header 'Content-Type: application/json' \
--data-raw '{
"tradingName": "MultilinePlan",
"name": "RemoveMemberFromGroup",
"externalReference": [
{
"externalReferenceType": "channel",
"name": "SFDC-B2C"
}
],
"partyCharacteristic": [
{
"name": "TransactionId",
"value": "36828876"
}
],
"relatedParty": [
{
"id": "00116335_0000637717",
"role": "Member/Line",
"@type": "Subscription"
}
]
}'
Definitions
Each of the request parameters is detailed.
| name | Type | description | required |
|---|
| payload.tradingName | string | The value must be 'MultilinePlan' for this functionality to work. | Y |
| payload.name | string | Name of the functionality | Y |
| externalReference | array | External reference of the individual or reference in other system. | Y |
| externalReference.externalReferenceType | string | External Reference Type, expected value is 'channel' | Y |
| externalReference.name | string | External reference name. In this case Channel name. Eg: 'SFDC-B2C' | Y |
| partyCharacteristic | array | Describes a given characteristic of an object or entity through a name/value pair. | Y |
| partyCharacteristic.name | string | Characteristics name. | Y |
| partyCharacteristic.value | string | Characteristics value. | Y |
| relatedParty | array | Related Entity reference. A related party defines party or party role linked to a specific entity | Y |
| relatedParty.id | string | Subscription ExternalID | Y |
| relatedParty.@type | string | Type of the related party. Expected value is "Subscription" | N |
| relatedParty.role | string | Role of party in Group for. Allowed values are "Member or Line" | Y |
Response
{
"id": "",
"partyCharacteristic": [
{
"name": "MtxResponse",
"valueType": "array",
"value": [
{
"RelatedMsgId": "Membership removed",
"TenantId": "LLA_PR"
}
]
}
]
}
Definitions
Each of the request parameters is detailed.
| name | Type | description | required |
|---|
| id | string | As per TMF database it's mandatory, it will be empty string | N |
| partyCharacteristic | array | Describes a given characteristic of an object or entity through a name/value pair. | N |
| partyCharacteristic.name | string | Characteristics name. | N |
| partyCharacteristic.value | string | Characteristics value. | N |
partyCharacteristic values
| characteristic name | type | description | required |
|---|
| RelatedMsgId | string | Related message for success response | N |
| TenantId | string | Tenant Id, Eg: LLA_PR | N |